Thumbstick 2 Click Driver

API for configuring and manipulating Thumbstick 2 Click driver. More...

Topics
	Thumbstick 2 Settings
	Settings of Thumbstick 2 Click driver.
	Thumbstick 2 MikroBUS Map
	MikroBUS pin mapping of Thumbstick 2 Click driver.

Functions
void	thumbstick2_cfg_setup (thumbstick2_cfg_t *cfg)
	Thumbstick 2 configuration object setup function.
err_t	thumbstick2_init (thumbstick2_t *ctx, thumbstick2_cfg_t *cfg)
	Thumbstick 2 initialization function.
err_t	thumbstick2_read_raw_adc (thumbstick2_t *ctx, uint16_t *raw_x, uint16_t *raw_y)
	Thumbstick 2 read raw adc function.
float	thumbstick2_get_angle (uint16_t raw_x, uint16_t raw_y)
	Thumbstick 2 get angle function.
uint8_t	thumbstick2_get_position (uint16_t raw_x, uint16_t raw_y)
	Thumbstick 2 get position function.
err_t	thumbstick2_set_duty_cycle (thumbstick2_t *ctx, float duty_cycle)
	Thumbstick 2 set duty cycle function.
err_t	thumbstick2_pwm_stop (thumbstick2_t *ctx)
	Thumbstick 2 stop PWM function.
err_t	thumbstick2_pwm_start (thumbstick2_t *ctx)
	Thumbstick 2 start PWM function.
uint8_t	thumbstick2_get_sw_pin (thumbstick2_t *ctx)
	Thumbstick 2 get SW pin function.

Detailed Description

API for configuring and manipulating Thumbstick 2 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

thumbstick2_cfg_setup()

void thumbstick2_cfg_setup

(

thumbstick2_cfg_t *

cfg

)

Thumbstick 2 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See thumbstick2_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

thumbstick2_get_angle()

float thumbstick2_get_angle	(	uint16_t	raw_x,
		uint16_t	raw_y )

Thumbstick 2 get angle function.

This function calculates and returns joystick angle in degrees from raw ADC values for X and Y axis.

Parameters

[in]	raw_x	: RAW X axis data (0-4095).
[in]	raw_y	: RAW Y axis data (0-4095).

Returns

Joystick angle in degrees.

Note

None.

thumbstick2_get_position()

uint8_t thumbstick2_get_position	(	uint16_t	raw_x,
		uint16_t	raw_y )

Thumbstick 2 get position function.

This function calculates and returns joystick position flag from raw ADC values for X and Y axis.

Parameters

[in]	raw_x	: RAW X axis data (0-4095).
[in]	raw_y	: RAW Y axis data (0-4095).

Returns

Joystick position flag. Refer to the position values macro definitions.

Note

None.

thumbstick2_get_sw_pin()

uint8_t thumbstick2_get_sw_pin

(

thumbstick2_t *

ctx

)

Thumbstick 2 get SW pin function.

This function returns the SW pin logic state.

Parameters

[in]

ctx

: Click context object. See thumbstick2_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

thumbstick2_init()

err_t thumbstick2_init	(	thumbstick2_t *	ctx,
		thumbstick2_cfg_t *	cfg )

Thumbstick 2 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See thumbstick2_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See thumbstick2_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

thumbstick2_pwm_start()

err_t thumbstick2_pwm_start

(

thumbstick2_t *

ctx

)

Thumbstick 2 start PWM function.

This function starts the PWM output.

Parameters

[in]

ctx

: Click context object. See thumbstick2_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

thumbstick2_pwm_stop()

err_t thumbstick2_pwm_stop

(

thumbstick2_t *

ctx

)

Thumbstick 2 stop PWM function.

This function stops the PWM output.

Parameters

[in]

ctx

: Click context object. See thumbstick2_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error.

Note

None.

thumbstick2_read_raw_adc()

err_t thumbstick2_read_raw_adc	(	thumbstick2_t *	ctx,
		uint16_t *	raw_x,
		uint16_t *	raw_y )

Thumbstick 2 read raw adc function.

This function reads the raw ADC for X and Y axis by using SPI serial interface.

Parameters

[in]	ctx	: Click context object. See thumbstick2_t object definition for detailed explanation.
[out]	raw_x	: RAW X axis data (0-4095).
[out]	raw_y	: RAW Y axis data (0-4095).

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

thumbstick2_set_duty_cycle()

err_t thumbstick2_set_duty_cycle	(	thumbstick2_t *	ctx,
		float	duty_cycle )

Thumbstick 2 set duty cycle function.

This function sets the PWM duty cycle.

Parameters

[in]	ctx	: Click context object. See thumbstick2_t object definition for detailed explanation.
[in]	duty_cycle	: PWM duty cycle value (0.0 to 1.0).

Returns

• 0 - Success,
• -1 - Error.

Note

None.